.\" $OpenBSD: pthread_yield.3,v 1.5 2013/06/05 03:44:50 tedu Exp $
.\"
.\" PUBLIC DOMAIN: No Rights Reserved. Marco S Hyman <marc@snafu.org>
.\"
.Dd $Mdocdate: June 5 2013 $
.Dt PTHREAD_YIELD 3
.Os
.Sh NAME
.Nm pthread_yield
.Nd yield control of the current thread
.Sh SYNOPSIS
.In pthread.h
.Ft void
.Fn pthread_yield "void"
.Sh DESCRIPTION
The
.Fn pthread_yield
function resets the accumulated time slice of the current thread and then
enters the thread scheduler, which resumes execution of the next thread ready
to run.
If no other thread is ready to run, control returns to the current thread.
.Sh SEE ALSO
.Xr pthreads 3
.Sh STANDARDS
.Fn pthread_yield
is a non-portable (but quite common) extension to
.St -p1003.1-2001 .
